feat: Initial Implementation of Open Graph (OG) Plugin #1

shahzan01 · 2025-06-02T13:28:40Z

PR: Implement Open Graph (OG) Plugin for Joomla SEO

Description

This PR introduces the System – OpenGraph Plugin into the joomla-projects/jacademy25_seo repository.
The plugin provides automatic Open Graph (OG) and related social metadata generation for Joomla pages, ensuring rich previews on social media platforms and improving SEO.

Approach

The feature has been developed incrementally to align with Joomla’s architecture and maintain stability.

Key Features

Category-Level Mappings, Article & Menu-Level Overrides, and Global Fallbacks
- Map og:title, og:description, og:image, and og:image:alt at the category level.
- Override values at the article level for fine-grained control.
- Menu item overrides take the highest priority for specific pages.
- Global defaults act as the final fallback when no overrides or mappings are set.
Admin & Editor-Friendly UI
- Dedicated OpenGraph tabs in articles, categories, and menu items.
- Placeholder indicators show the current value and its source Field.
- Grouped custom fields (text, image, image-alt) for consistency.
Developer Integration via OpengraphServiceInterface & MappableFieldInterface
Developers can make their own custom fields available for OpenGraph mapping by implementing a simple interface:
- Step 1: Extend your custom field class with OpenGraphMappableFieldInterface.
- Step 2: Implement the getOpengraphGroup() function.
- Step 3: In that function, return the OpenGraph group where you want your custom field to appear:
  - TEXT → for text-based OG fields (e.g., title, description).
  - IMAGE → for image fields (e.g., og:image).
  - IMAGE_ALT → for alt-text fields (e.g., og:image:alt).

Status

✅ Repository setup complete
✅ Manifest & language files created
✅ Global defaults, category mapping, and override hierarchy implemented
✅ Admin UI tabs for articles, menus, and categories
🛠 Testing on different page types (home, article, category, menu overrides)
🔜 Validation via Facebook/Twitter/LinkedIn debugger tools

Goal

To ensure automatic, accurate, and fully customizable Open Graph metadata for all site pages, improving shareability on platforms like Facebook, Twitter, and LinkedIn, while boosting the SEO-friendliness of the Joomla site.

…ements

…ugin

plugins/system/jacademyseo_opengraph/jacademyseo_opengraph.php

plugins/system/jacademyseo_opengraph/jacademyseo_opengraph.xml

.gitignore

plugins/system/opengraph/src/Extension/opengraph.php

plugins/system/opengraph/src/Extension/Opengraph.php

plugins/system/opengraph/src/Extension/opengraph.php

plugins/system/opengraph/src/Extension/Opengraph.php

plugins/system/opengraph/src/forms/opengraph.xml

…fields

…ph plugin

… in the category.

…up field also.

…e modular using the OGinterface

…the form

…025/seo-improvements

…projects/jacademy25_seo into feature/seo-improvements

plugins/system/opengraph/language/en-GB/plg_system_opengraph.ini

plugins/system/opengraph/language/en-GB/plg_system_opengraph.sys.ini

plugins/system/opengraph/opengraph.xml

administrator/components/com_content/src/Extension/ContentComponent.php

build/media_source/plg_system_opengraph/joomla.asset.json

plugins/system/opengraph/src/Extension/opengraph.php

Copilot

Pull Request Overview

This PR introduces the System – OpenGraph Plugin for Joomla, enabling automatic generation of Open Graph and Twitter Card metadata for improved social media sharing. The plugin implements a hierarchical override system with global defaults, category-level mappings, article overrides, and menu item overrides taking the highest priority.

Hierarchical metadata system supporting global defaults, category mappings, article forms, and menu overrides
Admin UI integration with dedicated OpenGraph tabs for articles, categories, and menu items
Developer integration interface allowing custom fields to be made available for OpenGraph mapping

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
plugins/system/opengraph/src/Extension/opengraph.php	Main plugin class implementing metadata generation and form integration
plugins/system/opengraph/src/Field/OpengraphField.php	Custom field type for selecting mappable fields in admin forms
plugins/system/opengraph/src/forms/	XML form definitions for OpenGraph configuration tabs
plugins/system/opengraph/opengraph.xml	Plugin manifest with configuration options
plugins/system/opengraph/language/	Language files for admin interface
libraries/src/Opengraph/OpengraphServiceInterface.php	Interface for components to provide mappable fields
build/media_source/plg_system_opengraph/	JavaScript and asset configuration for admin placeholder functionality
administrator/components/com_/src/Extension/Component.php	Implementation of OpengraphServiceInterface in core components

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

…ynamic based on the current component.

… types

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

plugins/system/opengraph/src/Extension/opengraph.php

…ues with variable scope

Copilot

Pull Request Overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 10 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

build/media_source/plg_system_opengraph/js/opengraph-placeholder.es6.js

plugins/system/opengraph/src/Extension/opengraph.php

plugins/system/opengraph/src/Extension/Opengraph.php

administrator/components/com_content/src/Extension/ContentComponent.php

plugins/system/opengraph/src/Extension/opengraph.php

plugins/system/opengraph/src/Extension/Opengraph.php

plugins/system/opengraph/src/Field/OpengraphField.php

plugins/system/opengraph/src/Extension/opengraph.php

libraries/src/Opengraph/OpengraphServiceInterface.php

…moved fallback to plugin method

plugins/system/opengraph/src/Extension/Opengraph.php

plugins/system/opengraph/src/Extension/opengraph.php

shahzan01 added 2 commits June 2, 2025 18:49

initial commit for jacademyseo_opengraph plugin for joomla seo improv…

77a6f18

…ements

feat : added manifest and language files for jacademyseo_opengraph pl…

eb22627

…ugin

This comment was marked as resolved.

Sign in to view

LadySolveig requested changes Jun 3, 2025

View reviewed changes

shahzan01 added 4 commits June 4, 2025 10:20

fix : rename plugin to opengraph and update language files

ece1af5

fix : file name changed to opengraph.php

905cca3

feat: added forms for article and category to opengraph plugin

085ff65

feat : add og tag injection into html

8cb7864

LadySolveig reviewed Jun 13, 2025

View reviewed changes

shahzan01 added 21 commits June 16, 2025 16:46

fix : added docblocks and comments

ce47b06

feat : form improvements - custom fields mapping and manual override …

7ba727c

…fields

feat : created opengraph service interface and field type for opengra…

768a2bf

…ph plugin

feat: add opengraph field mapping and form changes

6b71fbf

fix : updated form and used the interface check to render form

2fac558

Segregate fields for opengraph into different form dropdowns

4b65016

fix : Separated the mapping form and conditionally combined them only…

89149f9

… in the category.

fix : forms now correclty save values in both category and article

b05a861

feat : added custom fields options to opengraph mappings and used gro…

b41f698

…up field also.

fix : made some changes to the form and made isSupported function mor…

a6e28cd

…e modular using the OGinterface

feat : implemented the OGInterface in com_menus

fea4185

feat: add custom fields filtering to opengraph field

6d37b9b

feat : og tag injection into html

7cfde55

fix : used the component helper to get the article and category

1f95b29

fix : get custom fields for the respective category in dropdown

19fe1f7

Chore: Apply PHP-CS-Fixer formatting across the codebase

cbbff6c

Chore: Normalize line endings and fix code style via PHPCBF

419dfa7

feat : add string sanitization and truncate to the plugin

928ad4b

fix : sorted language strings

063adfa

feat : added the javascript to auto update the placeholder values in …

8a9441b

…the form

feat : added script for OpenGraph placeholder in build folder

30689d6

shahzan01 changed the title ~~feat: Initial Implementation of Auto Open Graph (OG) Tag Generation~~ feat: Initial Implementation of Open Graph (OG) Plugin Aug 19, 2025

shahzan01 added 2 commits September 1, 2025 19:22

feat : added support for multi article page view

3e47961

fix : run php-cs-fixer and sorted language strings

e63a335

bembelimen deleted the branch main September 12, 2025 12:04

bembelimen closed this Sep 12, 2025

Merge remote-tracking branch 'Academy2025_SEO/6.1-dev' into academy/2…

e2f0c94

…025/seo-improvements

bembelimen reopened this Sep 12, 2025

shahzan01 added 3 commits September 15, 2025 12:20

fix : Check PHP code style fixes

7e7aaea

Merge branch 'feature/seo-improvements' of https://github.com/joomla-…

775bc4b

…projects/jacademy25_seo into feature/seo-improvements

fix : removed the phpstan error

0f8c467

bembelimen requested changes Sep 18, 2025

View reviewed changes

bembelimen requested a review from Copilot September 19, 2025 09:24

Copilot AI reviewed Sep 19, 2025

View reviewed changes

shahzan01 added 5 commits September 30, 2025 21:45

fix : many minor fixes and improvements for SEO plugin

64bf434

fix : PHP-CS-Fixer applied

a635837

fixed the function call to include the missing parameter.

5b33522

fix : removed the hardcoded component name 'com_content' to make it d…

27b2c30

…ynamic based on the current component.

fix : made the OpenGraph plugin more generic to support other content…

a8d5996

… types

shahzan01 requested a review from Copilot October 1, 2025 13:43

Copilot AI reviewed Oct 1, 2025

View reviewed changes

LadySolveig requested changes Oct 1, 2025

View reviewed changes

plugins/system/opengraph/src/Extension/opengraph.php Outdated Show resolved Hide resolved

shahzan01 added 2 commits October 1, 2025 21:18

fix : added fallback for getModelName method if not exists in component

10b1014

fix : changed $cmp to $component to avoid confusion and potential iss…

bdc382e

…ues with variable scope

shahzan01 requested a review from Copilot October 1, 2025 15:55

Copilot AI reviewed Oct 1, 2025

View reviewed changes

shahzan01 added 2 commits October 2, 2025 09:46

fix : minor fixes and improvements

b721d72

fix : added getmodelname method to opengraph service interface and re…

78a4e3b

…moved fallback to plugin method

bembelimen requested changes Oct 3, 2025

View reviewed changes

plugins/system/opengraph/src/Extension/Opengraph.php Show resolved Hide resolved

plugins/system/opengraph/src/Extension/opengraph.php Outdated Show resolved Hide resolved

shahzan01 added 2 commits October 3, 2025 20:45

fix : add getModelName to MenusComponent

1a98cc5

fix : Rename opengraph.php to Opengraph.php for consistency

edd13bf

Uh oh!

feat: Initial Implementation of Open Graph (OG) Plugin #1

Are you sure you want to change the base?

feat: Initial Implementation of Open Graph (OG) Plugin #1

Uh oh!

Conversation

shahzan01 commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR: Implement Open Graph (OG) Plugin for Joomla SEO

Description

Approach

Key Features

Status

Goal

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shahzan01 commented Jun 2, 2025 •

edited

Loading